
/*
 * Copyright 2002-2019 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/*
 *版权所有2002-2019原作者。
 *
 *根据Apache许可证2.0版（“许可证”）许可；
 *除非符合许可证的规定，否则您不得使用此文件。
 *您可以在以下网址获取许可证副本
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 *除非适用法律要求或书面同意，否则软件
 *根据许可证分发是在“按原样”的基础上分发的，
 *无任何明示或暗示的保证或条件。
 *有关管理权限的特定语言，请参阅许可证
 *许可证下的限制。
 */

package org.springframework.context;

import java.util.Locale;

import org.springframework.lang.Nullable;

/**
 * Strategy interface for resolving messages, with support for the parameterization
 * and internationalization of such messages.
 *
 * <p>Spring provides two out-of-the-box implementations for production:
 * <ul>
 * <li>{@link org.springframework.context.support.ResourceBundleMessageSource}: built
 * on top of the standard {@link java.util.ResourceBundle}, sharing its limitations.
 * <li>{@link org.springframework.context.support.ReloadableResourceBundleMessageSource}:
 * highly configurable, in particular with respect to reloading message definitions.
 * </ul>
 *
 * @author Rod Johnson
 * @author Juergen Hoeller
 * @see org.springframework.context.support.ResourceBundleMessageSource
 * @see org.springframework.context.support.ReloadableResourceBundleMessageSource
 */
/**
 *用于解析消息的策略接口，支持参数化
 *以及此类信息的国际化。
 *
 *＜p＞Spring为生产提供了两种开箱即用的实现：
 *＜ul＞
 *＜li＞｛@link org.springframework.context.support.ResourceBundleMessageSource｝：已构建
 *在标准{@link java.util.ResourceBundle}之上，共享其限制。
 *<li>｛@link.org.springframework.context.support.RoadadableResourceBundleMessageSource｝：
 *高度可配置，特别是在重新加载消息定义方面。
 *</ul>
 *
 *@作者罗德·约翰逊
 *@作者Juergen Hoeller
 *@请参阅org.springframework.context.support.ResourceBundleMessageSource
 *@请参阅org.springframework.context.support.ReloadableResourceBundleMessageSource
 */
public interface MessageSource {

	/**
	 * Try to resolve the message. Return default message if no message was found.
	 * @param code the message code to look up, e.g. 'calculator.noRateSet'.
	 * MessageSource users are encouraged to base message names on qualified class
	 * or package names, avoiding potential conflicts and ensuring maximum clarity.
	 * @param args an array of arguments that will be filled in for params within
	 * the message (params look like "{0}", "{1,date}", "{2,time}" within a message),
	 * or {@code null} if none
	 * @param defaultMessage a default message to return if the lookup fails
	 * @param locale the locale in which to do the lookup
	 * @return the resolved message if the lookup was successful, otherwise
	 * the default message passed as a parameter (which may be {@code null})
	 * @see #getMessage(MessageSourceResolvable, Locale)
	 * @see java.text.MessageFormat
	 */
	/**
	 *尝试解析该消息。如果未找到消息，则返回默认消息。
	 *@param code要查找的消息代码，例如“calculator.noRateSet”。
	 *鼓励MessageSource用户将消息名称基于限定类
	 *或包名称，避免潜在冲突并确保最大限度的清晰度。
	 *@param args将为中的params填充的参数数组
	 *消息（参数看起来像消息中的“｛0｝”、“｛1，date｝”和“｛2，time｝”），
	 *或｛@code null｝如果没有
	 *@param defaultMessage查找失败时返回的默认消息
	 *@param locale进行查找的区域设置
	 *@如果查找成功，则返回解析的消息，否则
	 *作为参数传递的默认消息（可能是{@code null}）
	 *@see#getMessage（消息源可解析，区域设置）
	 *@参见java.text.MessageFormat
	 */
	@Nullable
	String getMessage(String code, @Nullable Object[] args, @Nullable String defaultMessage, Locale locale);

	/**
	 * Try to resolve the message. Treat as an error if the message can't be found.
	 * @param code the message code to look up, e.g. 'calculator.noRateSet'.
	 * MessageSource users are encouraged to base message names on qualified class
	 * or package names, avoiding potential conflicts and ensuring maximum clarity.
	 * @param args an array of arguments that will be filled in for params within
	 * the message (params look like "{0}", "{1,date}", "{2,time}" within a message),
	 * or {@code null} if none
	 * @param locale the locale in which to do the lookup
	 * @return the resolved message (never {@code null})
	 * @throws NoSuchMessageException if no corresponding message was found
	 * @see #getMessage(MessageSourceResolvable, Locale)
	 * @see java.text.MessageFormat
	 */
	/**
	 *尝试解析该消息。如果找不到消息，则视为错误。
	 *@param code要查找的消息代码，例如“calculator.noRateSet”。
	 *鼓励MessageSource用户将消息名称基于限定类
	 *或包名称，避免潜在冲突并确保最大限度的清晰度。
	 *@param args将为中的params填充的参数数组
	 *消息（参数看起来像消息中的“｛0｝”、“｛1，date｝”和“｛2，time｝”），
	 *或｛@code null｝如果没有
	 *@param locale进行查找的区域设置
	 *@返回解析的消息（从不｛@code null｝）
	 *如果没有找到相应的消息，@throws NoSuchMessageException
	 *@see#getMessage（消息源可解析，区域设置）
	 *@参见java.text.MessageFormat
	 */
	String getMessage(String code, @Nullable Object[] args, Locale locale) throws NoSuchMessageException;

	/**
	 * Try to resolve the message using all the attributes contained within the
	 * {@code MessageSourceResolvable} argument that was passed in.
	 * <p>NOTE: We must throw a {@code NoSuchMessageException} on this method
	 * since at the time of calling this method we aren't able to determine if the
	 * {@code defaultMessage} property of the resolvable is {@code null} or not.
	 * @param resolvable the value object storing attributes required to resolve a message
	 * (may include a default message)
	 * @param locale the locale in which to do the lookup
	 * @return the resolved message (never {@code null} since even a
	 * {@code MessageSourceResolvable}-provided default message needs to be non-null)
	 * @throws NoSuchMessageException if no corresponding message was found
	 * (and no default message was provided by the {@code MessageSourceResolvable})
	 * @see MessageSourceResolvable#getCodes()
	 * @see MessageSourceResolvable#getArguments()
	 * @see MessageSourceResolvable#getDefaultMessage()
	 * @see java.text.MessageFormat
	 */
	/**
	 *尝试使用包含在
	 *传入的｛@code MessageSourceResolutible｝参数。
	 *＜p＞注意：我们必须对此方法抛出｛@code NoSuchMessageException｝
	 *因为在调用此方法时，我们无法确定
	 *可解析的的｛@code defaultMessage｝属性是否为｛@code-null｝。
	 *@param resolvable存储解析消息所需属性的值对象
	 *（可能包括默认消息）
	 *@param locale进行查找的区域设置
	 *@返回解析的消息（从不｛@code null｝，因为
	 *｛@code MessageSourceResolutible｝-提供的默认消息必须为非null）
	 *如果没有找到相应的消息，@throws NoSuchMessageException
	 *（｛@code MessageSourceResolutible｝没有提供默认消息）
	 *@请参阅消息源可解析#getCodes（）
	 *@请参阅MessageSourceResolutible#getArguments（）
	 *@请参阅消息源可解析#getDefaultMessage（）
	 *@参见java.text.MessageFormat
	 */
	String getMessage(MessageSourceResolvable resolvable, Locale locale) throws NoSuchMessageException;

}
